home *** CD-ROM | disk | FTP | other *** search
/ BCI NET 2 / BCI NET 2.iso / archives / programming / misc / xref_v1.1.lha / XRef / Doc / english / rexxxref.doc < prev    next >
Encoding:
Text File  |  1995-01-09  |  4.2 KB  |  141 lines
  1.  
  2.  
  3. TABLE OF CONTENTS
  4.  
  5. rexxxref.library/--rexxhost--
  6. rexxxref.library/ExpungeXRef
  7. rexxxref.library/FindXRef
  8. rexxxref.library/LoadXRef
  9.  
  10.  
  11. rexxxref.library/--rexxhost--                    rexxxref.library/--rexxhost--
  12.  
  13.     HOST INTERFACE
  14.         rexxxref.library provides an ARexx function host interface that
  15.         enables ARexx programs to take advantage of the features of the
  16.         XRef-System.
  17.  
  18.         The function host library vector is located at offset -30 from the
  19.         library. This is the value you provide to ARexx in the AddLib()
  20.         function call.
  21.  
  22.     FUNCTIONS
  23.         FindXRef(STRING/A,CATEGORY,LIMIT/N,NOPATTERN/S,NOCASE/S,STEM)
  24.         LoadXRef(FILE/A,XREFPRI/N,LOCK/S,INDEX/S)
  25.         ExpungeXRef(CATEGORY,FILE,FORCE/S)
  26.  
  27.     EXAMPLES
  28.         /* xref.library ARexx example */
  29.         OPTIONS RESULTS
  30.  
  31.         IF ~SHOW('L','xref.library') THEN
  32.             CALL ADDLIB('xref.library',0,-30)
  33.  
  34.         /* load explicitly the sys_autodoc.xref */
  35.         IF LoadXRef('sys_autodoc.xref',10,,'INDEX') THEN
  36.            Say "sys_autodoc.xref loaded with priority 10 !"
  37.         ELSE
  38.            Say "Can't load sys_autodoc.xref"
  39.  
  40.         IF FindXRef('#?Window#?',,10,,,,) THEN
  41.             DO i = 1 TO xref.count
  42.                 Say "XRef     : " xref.i.Name
  43.                 Say "Type     : " xref.i.Type
  44.                 Say "NodeName : " xref.i.NodeName
  45.                 Say "File     : " xref.i.File
  46.                 Say "Path     : " xref.i.Path
  47.                 Say "Line     : " xref.i.Line
  48.             END
  49.         ELSE
  50.             Say "FindXRef() error : " ERRORTEXT(RC)
  51.         EXIT
  52.  
  53.     SEE ALSO
  54.         ParseXRef() ,XR_LoadXRef() ,XR_ExpungeXRef()
  55.  
  56. rexxxref.library/ExpungeXRef                      rexxxref.library/ExpungeXRef
  57.  
  58.     NAME
  59.         ExpungeXRef - expunge a/some xreffiles from memory
  60.  
  61.     SYNOPSIS
  62.         ExpungeXRef(CATEGORY,FILE,FORCE/S)
  63.  
  64.     FUNCTION
  65.         This is the Rexx-Function-Interface to the XR_ExpungeXRef() function
  66.         of the xref.library.
  67.  
  68.     INPUTS
  69.         CATEGORY - category of xreffiles to expunge
  70.         FILE     - expunge only the given file
  71.         FORCE    - expunge also xreffiles, which are locked
  72.  
  73.     RESULTS
  74.         Set RC to RC_WARN, if no xreffiles was expunged. Otherwise
  75.         set to RC_OK.
  76.  
  77.     SEE ALSO
  78.         LoadXRef() ,FindXRef() ,XR_ExpungeXRef()
  79.  
  80. rexxxref.library/FindXRef                            rexxxref.library/FindXRef
  81.  
  82.     NAME
  83.         FindXRef - searchs for a given pattern and returns the xref entries
  84.  
  85.     SYNOPSIS
  86.         FindXRef(STRING/A,CATEGORY,LIMIT/N,NOPATTERN/S,NOCASE/S,STEM)
  87.  
  88.     FUNCTION
  89.         Searchs for a given pattern or string. If one or more xref entries
  90.         are found, this function returns the full information about the xref
  91.         entry in the specified stem variable.
  92.  
  93.     INPUTS
  94.         STRING   - string/pattern to search for
  95.         CATEGORY - category to search in
  96.         LIMIT    - maximal number of entries to return
  97.         NOPATTERN- string isn't a pattern
  98.         NOCASE   - ignore case ('A'=='a')
  99.         STEM     - stem variable to use, if not specified it uses the
  100.                    "XRef" as stem base name !
  101.                    The following stem field are supported :
  102.                    XRef.Count
  103.                    XRef.n.Type
  104.                    XRef.n.Name
  105.                    XRef.n.NodeName
  106.                    XRef.n.File
  107.                    XRef.n.Path
  108.                    XRef.n.Line
  109.  
  110.     RESULTS
  111.         Set RC to WARN,if no entry was found. Otherwise set to RC_OK
  112.  
  113.     SEE ALSO
  114.         LoadXRef() ,ExpungeXRef() ,ParseXRef()
  115.  
  116. rexxxref.library/LoadXRef                            rexxxref.library/LoadXRef
  117.  
  118.     NAME
  119.         LoadXRef - loads a xreffile into memory
  120.  
  121.     SYNOPSIS
  122.         LoadXRef(FILE/A,XREFPRI/N,LOCK/S,INDEX/S)
  123.  
  124.     FUNCTION
  125.         This is the Rexx-Interface function to the xref.library XR_LoadXRef()
  126.         function.
  127.  
  128.     INPUTS
  129.         FILE    - xreffile to load
  130.         XREFPRI - priority to use for this xreffile (Enqueue())
  131.         LOCK    - lock this xreffile
  132.         INDEX   - create an index for this xreffile
  133.  
  134.     RESULTS
  135.         Set RC to RC_WARN, if the xreffile could not loaded. Otherwise
  136.         set to RC_OK.
  137.  
  138.     SEE ALSO
  139.         FindXRef() ,ExpungeXRef() ,XR_LoadXRef()
  140.  
  141.